Updating the BizTalk Server Monitoring Agent

Stay ahead with the latest features and improvements! This guide shows you how to update the Microsoft BizTalk Server Monitoring Agent for Nodinite quickly and safely.

Note
Choose Your Update Method Based on Deployment Architecture:

Typical Production Deployment (Agent on BizTalk Server):
In most production scenarios, the BizTalk Server Monitoring Agent runs on dedicated BizTalk Server(s) separate from the Nodinite Application Server. For these deployments, use the MSI-based update process documented on this page. This approach is required when the agent runs on a server that does not host the Nodinite platform components.

Co-Hosted Deployment (Agent on Nodinite App Server):
In development, POC, or single-box environments where BizTalk Server and Nodinite are co-hosted on the same machine, you can use either approach:

Nodinite v7 Portal-Based Scripted Installation - Modern automated approach via PowerShell scripts generated from the Portal. See Install Nodinite v7 or Update Nodinite v7 for details.

MSI-Based Installation - Traditional approach documented on this page.

When to use which approach:

MSI method - Agent installed on separate BizTalk Server (typical production), or preference for traditional installation

Portal-based v7 method - Co-hosted environments, developers/POCs, preference for automated scripted deployment

Release notes

For detailed information about each release, visit the Release Notes for the BizTalk Monitoring Agent.

Important
Always read the release notes before updating to understand new features, bug fixes, and potential breaking changes.

Running Version

You can view the installed version in the 'Version' text box.

Check the version in the README.txt file.

Alternatively, check the file details property on the local installation:

File version property in Windows Explorer.

PreReq: Ensure you have already installed the Microsoft BizTalk Server Monitoring Agent before updating. The service account must have Logon as Service Right. See Prerequisites for BizTalk Monitoring Agent for more details.

Note
You must be a local administrator to install or update Windows Services.

Compatibility and versioning issues

5.x → 5.1
- The new Cluster support requires a monitoring database update. The agent attempts this automatically, but you may need to update the database manually if access rights are insufficient. During setup, if you see an exception, update the database and retry starting the service.
See the Agent Database user guide for more information.
4.1.0.x → 4.1.0.y
- New features have been added. Review your settings and Monitor Views after updating.
- LogText written by LogAgents now only changes when the state does.
4.0 → 4.1
- Updating from older XML-based versions requires reconfiguration.

Step 1: Start the installer

Double-click the MSI file to begin updating the Microsoft BizTalk Server Monitoring Agent.

Start the update by running the MSI file.

Step 2: Welcome Screen

After launching the MSI, you'll see a Welcome screen.

Welcome screen for the update process.

Click 'Next' to continue or 'Cancel' to exit the installer.

Step 3: Accept End User License Agreement (EULA)

The Licensee is responsible for ensuring Nodinite products are used according to the End User License Agreement. Confirm you have the rights to install and modify the environment before proceeding.

End User License Agreement (EULA) screen.

Step 4: Custom Setup

Select the components and installation location. We recommend using the default settings.

Custom setup options for the update process.

Note
If you change the installation location, your old configuration will be lost.

Click 'Next' to continue or 'Cancel' to exit.

Step 5: Service Account Information

Enter the credentials for the Account that will run the Microsoft BizTalk Server Monitoring Agent. This account is used to log on and query the monitored databases.

Domain: The server's domain name. For local accounts, use the server name or a dot (.).
User: The account name.
Password: The account password.

Note
The account must have 'Log on as Service Right'.

Enter domain, user, and password for the service account.

Click 'Next' to continue or 'Cancel' to exit.

Insufficient Privileges

If the account information does not meet Prerequisites, you will see an error message.

Error message for insufficient privileges.

The most common reason is that the account is not allowed to run as a service or is not a local Administrator. Follow the How to set Logon as a Service right guide and click retry. If the problem persists, click cancel and restart with valid credentials.

Tip
Check the local event log for errors (both System and Application).

Step 6: Completed setup

The final step of the update process will show either a success or a premature exit.

Successful update example.

Click 'Finish' to exit the installer.

When the setup finishes, the default text editor will open a file named 'README.txt'. This file contains additional information you need to manage the agent as a Monitoring Agents.

README.txt file with post-installation information.